home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-04 / soseng.zip / SOSENGN.DOC < prev    next >
Text File  |  1993-03-17  |  11KB  |  286 lines
  1.  
  2.                   SOS ENGINE TEST DRIVE INTRODUCTION
  3.  
  4. Have you ever wondered exactly what your application was doing in the
  5. background, what files it was accessing, how many bytes it was reading
  6. or writing, or how other low level functions were being performed?
  7.  
  8. We did.  In fact, the first version of this program was born a couple
  9. of years ago out of desperation when we could not determine why one of our
  10. applications would not print correctly when run on a network.  Since then
  11. we have saved countless hours during the develpment/alpha/beta cycles.
  12.  
  13. We have also used this program to monitor our clients systems and to record
  14. problems for later analysis.  The usefullness of this program is limited
  15. only by your understanding of what it does.
  16.  
  17.  
  18.                                 OVERVIEW
  19.  
  20. The SOS ENGINE consists of two parts.  The first is the 'ENGINE' which
  21. is an 11k memory resident module that can be loaded anywhere in memory.
  22. The engine remains idle in memory until you activate it from your
  23. application.  When activitated, it begins logging selected activities to
  24. a pre-determined file.  Each log entry is time stamped, in 24 hour time,
  25. with a resolution of 1/100th of a second.
  26.  
  27. The second part consists of a standard OBJ file that you link with your
  28. application.  The OBJ file contains 18 functions written entirely in
  29. assembly language, and adds less than 600 bytes to the size of your
  30. finished application.  Each of the eighteen functions are designed to help
  31. you tailor the output of the engine to suit your needs as closely as
  32. possible.
  33.  
  34.  
  35.                               APPLICATION
  36.  
  37. The SOS ENGINE can be used as a debugging tool during the development,
  38. Alpha, and Beta cycles of application development and testing.  If desired,
  39. the code can be left in the application when it is finished as it requires
  40. very little overhead.  The engine could be distributed with the application
  41. and loaded only if needed.  This is a great way to provide an un-paralleled
  42. level of support.
  43.  
  44. It can be extremely usefull for developers of vertical applications.  They
  45. could easily monitor the execution of their software all the time, or at
  46. times when errors are likely to occur.  Log files can easily be printed out
  47. and faxed or mailed to the developer, so he has exact documentation as to
  48. what the application was doing when a problem occurred.
  49.  
  50.  
  51.                            SOS ENGINE REFERENCE
  52.  
  53. The SOS ENGINE consists of two very small modules:
  54.  
  55. SOSENGN.EXE -- This is the memory resident engine portion of the program.
  56. It can be loaded any time you like prior to running an application that
  57. activates it.  It can be loaded into 'HIGH' memory without problem.
  58.  
  59. The engine needs no parameters, and will maintain a log file called SOSENGN
  60. in the directory where the program was first called.  You can unload the
  61. engine from memory by using the /U command line parameter. (i.e. SOSENGN /U)
  62. You may also specify a file name by passing a fully qualified DOS file name
  63. as a command line parameter. (i.e. SOSENGN C:\LOGS\MYLOG.DAT )
  64.  
  65.  
  66.  
  67. SOSFUNC.OBJ -- This is the 'LIBRARY' portion of the program. This file
  68. contains 18 callable functions you may use to control the output of the
  69. engine module.  It has been tested with Clipper, BASIC, Turbo Pascal,
  70. and C, and should work with any dialect of those languages.  It is written
  71. in 100% Assembler, with no language particulars, so it should be pretty much
  72. generic.
  73.  
  74.  
  75.                  USING THE FUNCTION LIBRARY WITH BASIC
  76.  
  77. You can use any of the functions in BASIC by linking the OBJ file with
  78. your application, then CALLing the desired function.
  79.  
  80.   Example:  CALL SeOnLog
  81.  
  82. This will activate engine's logging functions. Please look at the file
  83. EXAMPLE.BAS for more information.
  84.  
  85.  
  86.                 USING THE FUNCTION LIBRARY WITH CLIPPER
  87.  
  88. A Clipper application would simply link the OBJ file in the ROOT of their
  89. application ( DO NOT OVERLAY ) and call the desired function as a Clipper
  90. type function.
  91.  
  92.   Example:  SeOnLog()
  93.  
  94. This will activate engine's logging functions as in the BASIC example.
  95. Please look at the file EXAMPLE.PRG for more information.
  96.  
  97.  
  98.                    USING THE FUNCTION LIBRARY WITH C
  99.  
  100. You need only link the OBJ file with your application and call the desired
  101. function.  Please see the file EXAMPLE.C for more information.
  102.  
  103.  
  104.                 USING THE FUNCTION LIBRARY TURBO PASCAL
  105.  
  106. Turbo Pascal requires a little more work.  Please look at the file EXAMPLE.PAS
  107. for a detailed example of how to use the SOS-ENGINE.
  108.  
  109.  
  110.                        FUNCTION LIBRARY REFERENCE
  111.  
  112.  
  113.    SeOnLog      -- Turns on logging functions.
  114.  
  115.    SeOffLog     -- Turns off logging functions.
  116.  
  117.  
  118.  
  119. The following functions can be called whether the engine on or off.  The
  120. defaule for ALL finctions is ON.
  121.  
  122.  
  123.    SeOnRead      -- Turns on logging of file reads. Records the handle number
  124.                     of the file read, and the number of bytes read.
  125.  
  126.    SeOffRead     -- Turns off logging of file reads.
  127.  
  128.    SeOnWrite     -- Turns on logging of file writes. Records the handle number
  129.                     of the file written to, and the number of bytes written.
  130.  
  131.    SeOffWrite    -- Turns off logging of file writes.
  132.  
  133.    SeOnPointer   -- Turns on logging of file pointer movement. Records the
  134.                     handle number of the file being accessed.
  135.  
  136.    SeOffPointer  -- Turns off logging of file writes.
  137.  
  138.    SeOnMemory    -- Turns on logging of memory allocation requests, memory
  139.                     deallocation requests, and memory modfication requests.
  140.  
  141.    SeOffMemory   -- Turns off logging of memory functions.
  142.  
  143.    SeOnCl        -- Turns on logging of command line.
  144.  
  145.    SeOffCl       -- Turns off logging of command line.
  146.  
  147.    SeOnFile      -- Turns on logging of file opens, closes, creations,
  148.                     deletions, and renames.
  149.  
  150.    SeOffFile     -- Turns off logging of file activities.
  151.  
  152.    SeOnDir       -- Turns on logging of directory operations such as
  153.                     creations and removals.
  154.  
  155.    SeOffDir      -- Turns off logging of directory activities.
  156.  
  157.    SeOnFa        -- Turns on logging of file attribute activities such as
  158.                     getting and setting of file date ant time settings and
  159.                     getting and setting file attribute bits.
  160.  
  161.    SeOffFa       -- Turns off logging of file attribute activities.
  162.  
  163.  
  164.                           LOG FILE STATEMENTS
  165.  
  166.  
  167.    CmdLin        -- Records whatever was typed at the command line.
  168.  
  169.    Time Changed  -- Records that the user on the application changed the
  170.                     system time.
  171.  
  172.    Create        -- Records the name of a newly created file.
  173.  
  174.    RmDir         -- Records the name of a removed directory.
  175.  
  176.    MkDir         -- Records the name of a created directory.
  177.  
  178.    Open #        -- Records the name and DOS handle of an opened file.
  179.  
  180.    Close #       -- Records the DOS handle on a closed file.
  181.  
  182.    Read #        -- Records the DOS handle and the number of bytes read.
  183.  
  184.    Write #       -- Records the DOS handle and the number of bytes written.
  185.  
  186.    Delete        -- Records the name of the file deleted.
  187.  
  188.    MvPtr #       -- Records the DOS handle of the current file when the
  189.                     file pointer was moved.
  190.  
  191.    GetFA         -- Records file name of a file where the application requested
  192.                     information about its current attribute settings.
  193.  
  194.    SetFA         -- Records file name of a file where the application changed
  195.                     its current attribute settings.
  196.  
  197.    GetFDT        -- Records file name of a file where the application requested
  198.                     information about its date and time stamps.
  199.  
  200.    SetFDT        -- Records file name of a file where the application changed
  201.                     its date and time stamps.
  202.  
  203.    Rename        -- Records the name of a renamed file.
  204.  
  205.    MemAlloc      -- Records that an application requested memory.
  206.  
  207.    RelMem        -- Records that an application released previously allocated
  208.                     memory.
  209.  
  210.    ModMemAlloc   -- Records that an application modified previously allocated
  211.                     memory.
  212.  
  213.  
  214.                      TEST DRIVE VERSION INFORMATION
  215.  
  216.  
  217. You may use this program for 30 days as a TEST DRIVE product. If you continue
  218. to use the program after that 30 day period, you are required to register.
  219.  
  220. The TEST DRIVE version of this program will only log 1000 lines of information
  221. each time it is loaded.  Registered users will receive the latest version, with
  222. no TEST DRIVE restrictions or annoyances.
  223.  
  224. DISK VENDORS and BBS OPERATORS.  You are free to distribute this program
  225. in any form as long as it is unmodified, includes this file and no fee in
  226. excess of $5.00 is charged.
  227.  
  228. The SOS-ENGINE can be purchased in two ways.  The single user version is for
  229. use by one person only.  This is suitable for a developer who wishes to use
  230. the program as a debugging tool on his own computer.
  231.  
  232. If you want to be able to distribute the SOS-ENGINE with your applications
  233. you must purchase the Run-Time version.  This version allows you to distrubute
  234. the SOS-ENGINE royalty free as part of your application or software product.
  235.  
  236.  
  237.  
  238.  
  239.  
  240.                         SOS-ENGINE Order Form
  241.  
  242.  
  243. ______ SOS-ENGINE single user version .................. $  49.00  $ ______
  244.  
  245. ______ SOS-ENGINE Run-Time version ..................... $ 495.00  $ ______
  246.  
  247.  
  248.  
  249. California orders please add Sales Tax .................... 7.75%  $ ______
  250.  
  251.  
  252.            ALL ORDERS SHIPPED 2nd DAY AIR...  Shipping & Handling  $   4.00
  253.  
  254.  
  255.                                                             Total  $ ______
  256.                                              
  257.  
  258.  
  259.  
  260.          Master Card, VISA, and Approved purchase orders accepted.
  261.  
  262.                          ORDER LINE: 1-800-388-2761
  263.  
  264.  
  265.   Name / Contact: _____________________________________________________
  266.  
  267.   Company: ____________________________________________________________
  268.  
  269.   Address: ____________________________________________________________
  270.  
  271.          : ____________________________________________________________
  272.  
  273.          : ____________________________________________________________
  274.  
  275.     Phone: ______________________________ FAX: ________________________
  276.  
  277.   MC/VISA: ______________________________ EXP: ________________________
  278.  
  279.  
  280.                      Please complete and mail with payment:
  281.  
  282.                               Solid Oak Software
  283.                                  P.O. Box 6826
  284.                            Santa Barbara, CA 93160
  285.                         805-568-5414  FAX 805-568-5419
  286.